[lldb] Proofread python-reference.rst #149643
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@llvm/pr-subscribers-lldb Author: Kazu Hirata (kazutakahirata) ChangesFull diff: https://github.com/llvm/llvm-project/pull/149643.diff 1 Files Affected:
diff --git a/lldb/docs/use/python-reference.rst b/lldb/docs/use/python-reference.rst
index 325d0685d9d38..4292714c9c208 100644
--- a/lldb/docs/use/python-reference.rst
+++ b/lldb/docs/use/python-reference.rst
@@ -748,7 +748,7 @@ For instance, if the string you are completing is "Test" and the available compl
return {"completion": "Test1", "mode" : "partial"}
-and then lldb will add the "1" at the curson and advance it after the added string,
+and then lldb will add the "1" at the cursor and advance it after the added string,
waiting for more completions. But if "Test1" is the only completion, return:
.. code-block:: python
@@ -933,7 +933,7 @@ that goal:
Using the lldb.py module in Python
----------------------------------
-LLDB has all of its core code build into a shared library which gets used by
+LLDB has all of its core code built into a shared library which gets used by
the `lldb` command line application. On macOS this shared library is a
framework: LLDB.framework and on other unix variants the program is a shared
library: lldb.so. LLDB also provides an lldb.py module that contains the
@@ -956,7 +956,7 @@ For sh and bash:
$ export PYTHONPATH=`lldb -P`
-Alternately, you can append the LLDB Python directory to the sys.path list
+Alternatively, you can append the LLDB Python directory to the sys.path list
directly in your Python code before importing the lldb module.
Now your python scripts are ready to import the lldb module. Below is a python
@@ -1093,11 +1093,11 @@ Writing Target Stop-Hooks in Python
Stop hooks fire whenever the process stops just before control is returned to the
user. Stop hooks can either be a set of lldb command-line commands, or can
-be implemented by a suitably defined Python class. The Python based stop-hooks
-can also be passed as set of -key -value pairs when they are added, and those
+be implemented by a suitably defined Python class. The Python-based stop-hooks
+can also be passed as a set of -key -value pairs when they are added, and those
will get packaged up into a SBStructuredData Dictionary and passed to the
constructor of the Python object managing the stop hook. This allows for
-parametrization of the stop hooks.
+parameterization of the stop hooks.
To add a Python-based stop hook, first define a class with the following methods:
|
JDevlieghere
approved these changes
Jul 20, 2025
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/18/builds/19273 Here is the relevant piece of the build log for the reference |
This was referenced Jul 23, 2025
mahesh-attarde
pushed a commit
to mahesh-attarde/llvm-project
that referenced
this pull request
Jul 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.